JAMSRESTAPI Web Service
GetJob_GetJobDocumentationById
JAMSRESTAPI Web Service > All Operations Resource Group : Job_GetJobDocumentationById (Get)

Resource Path: /api/job/doc/{id}

Uri: http://doc.jamsscheduler.com/api/job/doc/{id}

Description
Get the Documentation for a given Job by name.
Parameters
NameDescriptionData Type
The Job IDinteger
Documentation Typestring
Render Typestring
Response

The response body is of type Job.

OK

Overview

Job
description : string
elements : Array[Element]
elementName : string
elementTypeName : string
elementTypeId : integer
elementId : integer
elementUid : string
ownerUid : string
inherited : boolean
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
elementKind : string
elementState : string
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
writeToEntry : boolean
writeToHistory : boolean
tabName : string
sortOrder : integer
validateTypeNameSSO : string
formatString : string
addMenuText : string
categoryName : string
categoryAddMenuText : string
categorySortOrder : integer
sourceElements : Array[Element]
elementName : string
elementTypeName : string
elementTypeId : integer
elementId : integer
elementUid : string
ownerUid : string
inherited : boolean
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
elementKind : string
elementState : string
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
writeToEntry : boolean
writeToHistory : boolean
tabName : string
sortOrder : integer
validateTypeNameSSO : string
formatString : string
addMenuText : string
categoryName : string
categoryAddMenuText : string
categorySortOrder : integer
jobID : integer
jobName : string
qualifiedName : string
parameters : Array[Param]
allowEntry : boolean
dataType : string
defaultFormat : string
defaultValue : string
encrypt : boolean
helpText : string
hide : boolean
inherited : boolean
jobID : integer
lastChangeUTC : string
length : integer
mustFill : boolean
parameterOrigin : string
paramId : integer
paramName : string
prompt : string
required : boolean
sequence : integer
uppercase : boolean
validationData : string
validationType : string
variableID : integer
variableName : string
variableNameIsRelative : boolean
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
encryptionId : integer
newEncryptedValue : string
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
source : string
methodID : integer
methodName : string
lastChangeUTC : string
lastChangedBy : string
parentFolderID : integer
parentFolderName : string
maxBufferedIOCount : integer
maxDirectIOCount : integer
maxWorkingSetPeak : integer
maxPageFaults : integer
maxCpuTime : DeltaTime
totalSeconds : integer
maxElapsedTime : DeltaTime
totalSeconds : integer
maxCount : integer
minDirectIOCount : integer
minBufferedIOCount : integer
minWorkingSetPeak : integer
minPageFaults : integer
minCpuTime : DeltaTime
totalSeconds : integer
minElapsedTime : DeltaTime
totalSeconds : integer
lastAutosubmitUTC : string
minCount : integer
avgPageFaults : integer
avgCpuTime : DeltaTime
totalSeconds : integer
avgElapsedTime : DeltaTime
totalSeconds : integer
avgCount : integer
avgWorkingSetPeak : integer
lastFatalUTC : string
lastErrorUTC : string
lastWarningUTC : string
lastResetUTC : string
lastSuccessUTC : string
lastInfoUTC : string
avgBufferedIOCount : integer
avgDirectIOCount : integer
tagIds : Array[]
tags : Array[Tag]
tagId : integer
tagName : string
inheritedTagIds : Array[]
acl : ACL
genericACL : Array[ACE]
identifier : string
inherited : boolean
flags : string
accessList : Array[string]
See Also
All Operations Resource GroupJAMSRESTAPI Web Service